Scripting > CxVhs > VhsClient Helper Objects > GetPointStatsExResp Object

GetPointStatsExResp Object

The GetPointStatsExResp object is used in:

Properties

Property SubType Read Only Description

Count

Integer

Yes

Returns the number of responses in the array.

Error

Integer

Yes

Returns the VHS error message. A value of zero indicates success. See CxVhs Error Codes.

PointError

Integer

Yes

Returns the history error of an entry in the array. The history error explains if there was an error in retrieval for a particular entry based on tagstring/timestamp. This field is an array of Integer subtypes.

Statistics

Variant

Yes

Returns the entry count, timestamp start, timestamp end, and expiration days for a point in the VHS.

Type: HistoryStats

Statistics are stored in an indexed array as HistoryStats objects.

Version

Integer

Yes

Returns the message version. This property ensures compatibility with software release versions of the VHS.


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.